/* 
 * Copyright 2011 Karl Pauls karlpauls@gmail.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.kalpatec.pojosr.framework.felix.framework.util;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.jar.Attributes;

/**
 * Simple utility class that creates a map for string-based keys. This map can
 * be set to use case-sensitive or case-insensitive comparison when searching
 * for the key. Any keys put into this map will be converted to a
 * <tt>String</tt> using the <tt>toString()</tt> method, since it is only
 * intended to compare strings.
 **/
public class StringMap<A> implements Map<String,A>
{
    private TreeMap<String,A> m_map;

    public StringMap()
    {
        this(true);
    }

    public StringMap(boolean caseSensitive)
    {
        m_map = new TreeMap<String,A>(new StringComparator(caseSensitive));
    }

    public StringMap(Attributes map, boolean caseSensitive)
    {
    	this(caseSensitive);
        assert map!=null;
        
        if( map!=null ) {
        	
        	for( Map.Entry<Object,Object> e : map.entrySet() ) {
        		
        		m_map.put( e.getKey().toString(), (A)e.getValue());
        	}
        }
    }

    public boolean isCaseSensitive()
    {
        return ((StringComparator) m_map.comparator()).isCaseSensitive();
    }

    public void setCaseSensitive(boolean b)
    {
        if (isCaseSensitive() != b)
        {
            TreeMap<String,A> map = new TreeMap<String,A>(new StringComparator(b));
            map.putAll(m_map);
            m_map = map;
        }
    }

    @Override
    public int size()
    {
        return m_map.size();
    }

    @Override
    public boolean isEmpty()
    {
        return m_map.isEmpty();
    }

    
   @Override
   public A put(String key, A value)
    {
        return (A) m_map.put(key, value);
    }
    
    @Override
	public void putAll(Map<? extends String, ? extends A> map) {
        for (Map.Entry<? extends String, ? extends Object>  entry : map.entrySet() )
        {
            put(entry.getKey(), (A) entry.getValue());
        }
		
	}

	@Override
	public void clear()
    {
        m_map.clear();
    }

	@Override
    public Set<String> keySet()
    {
        return m_map.keySet();
    }

	@Override
    public Collection<A> values()
    {
        return (Collection<A>) m_map.values();
    }


	@Override
	public Set<Entry<String, A>> entrySet() {
		return m_map.entrySet();
	}

	@Override
    public String toString()
    {
        return m_map.toString();
    }

	@Override
	public boolean containsKey(Object key) {
        return m_map.containsKey(key);
	}

	@Override
	public boolean containsValue(Object value) {
        return m_map.containsValue(value);
	}

	@Override
	public A get(Object key) {
		return m_map.get(key);
	}

	@Override
	public A remove(Object key) {
        return m_map.remove(key);
	}
}